home *** CD-ROM | disk | FTP | other *** search
/ ftp.whtech.com / ftp.whtech.com.7z / ftp.whtech.com / emulators / mess / MESS 0.133 / Macintosh / MessMenu 0.7.0 OSX uni.dmg / docs / config.txt < prev    next >
Encoding:
Text File  |  2009-06-19  |  35.9 KB  |  978 lines

  1. This file describes general usage information about MAME. It is intended
  2. to cover aspects of using and configuring the program that are common
  3. across operating systems. For additional OS-specific options, please see
  4. the separate documentation for your particular version of MAME.
  5.  
  6.  
  7.  
  8. Using the program
  9. -----------------
  10.  
  11. The usual way to run MAME is by telling it to run a particular game:
  12.  
  13.     mame <gamename> [options]
  14.  
  15. For example:
  16.  
  17.     mame robby -nosound
  18.  
  19. ...will run Robby Roto without sound. There are many, many options
  20. available. All commonly supported options are listed below. Options that
  21. are specific to one operating system or version of MAME will be listed
  22. in a separate document.
  23.  
  24. An alternative way to run MAME is to give it a command:
  25.  
  26.     mame <command> [parameters]
  27.  
  28. For example:
  29.  
  30.     mame -listsource gridlee
  31.  
  32. ...will print the name of the source file where the gridlee driver lives
  33. to the screen. There are just a handful of these commands in MAME. They
  34. are all listed below, just before the options list.
  35.  
  36.  
  37.  
  38. Default Keys
  39. ------------
  40.  
  41. All the keys below are fully configurable in the user interface. This list
  42. shows the standard keyboard configuration.
  43.  
  44. Tab       Toggles the configuration menu.
  45.  
  46. ~         Toggles the On Screen Display. When the on-screen display is
  47.           visible, you can use the following keys to control it:
  48.  
  49.              Up - select previous parameter to modify
  50.              Down - select next parameter to modify
  51.              Enter - reset parameter value to its default
  52.  
  53.              Left - decrease the value of the selected parameter
  54.              Control+Left - decrease the value by 10x
  55.              Shift+Left - decrease the value by 0.1x
  56.              Alt+Left - decrease the value by the smallest amount
  57.  
  58.              Right - increase the value of the selected parameter
  59.              Control+Right - increase the value by 10x
  60.              Shift+Right - increase the value by 0.1x
  61.              Alt+Right - increase the value by the smallest amount
  62.  
  63. P         Pauses the game.
  64.  
  65. Shift+P   While paused, advances to next frame.
  66.  
  67. F2        Service Mode for games that support it.
  68.  
  69. F3        Resets the game.
  70.  
  71. Shift+F3  Performs a "hard reset", which tears everything down and re-
  72.           creates it from scratch. This is a more thorough and complete
  73.           reset than an F3.
  74.  
  75. F4        Shows the game palette, decoded GFX, and any tilemaps. Use the
  76.           Enter key to switch between the three modes (palette, graphics,
  77.           and tilemaps). Press F4 again to turn off the display. The key
  78.           controls in each mode vary slightly:
  79.  
  80.              * Palette/colortable mode:
  81.                 [ ] - switch between palette and colortable modes
  82.                 Up/Down - scroll up/down one line at a time
  83.                 Page Up/Page Down - scroll up/down one page at a time
  84.                 Home/End - move to top/bottom of list
  85.                 -/+ - increase/decrease the number of colors per row
  86.                 Enter - switch to graphics viewer
  87.  
  88.              * Graphics mode:
  89.                 [ ] - switch between different graphics sets
  90.                 Up/Down - scroll up/down one line at a time
  91.                 Page Up/Page Down - scroll up/down one page at a time
  92.                 Home/End - move to top/bottom of list
  93.                 Left/Right - change color displayed
  94.                 R - rotate tiles 90 degrees clockwise
  95.                 -/+ - increase/decrease the number of tiles per row
  96.                 Enter - switch to tilemap viewer
  97.  
  98.              * Tilemap mode:
  99.                 [ ] - switch between different tilemaps
  100.                 Up/Down/Left/Right - scroll 8 pixels at a time
  101.                 Shift+Up/Down/Left/Right - scroll 1 pixel at a time
  102.                 Control+Up/Down/Left/Right - scroll 64 pixels at a time
  103.                 R - rotate tilemap view 90 degrees clockwise
  104.                 -/+ - increase/decrease the zoom factor
  105.                 Enter - switch to palette/colortable mode
  106.  
  107.           Note: Not all games have decoded graphics and/or tilemaps.
  108.  
  109. F6        Toggle cheat mode (if started with "-cheat").
  110.  
  111. F7        Load a save state. You will be requested to press a key to
  112.           determine which save state you wish to load. Note that the save
  113.           state feature is not supported for a large number of drivers. If
  114.           support is not enabled for a given driver, you will receive a
  115.           warning when attempting to save or load.
  116.  
  117. Shift+F7  Create a save state. Requires an additional keypress to identify
  118.           the state, similar to the load option above.
  119.  
  120. F8        Decrease frame skip on the fly.
  121.  
  122. F9        Increase frame skip on the fly.
  123.  
  124. F10       Toggle speed throttling.
  125.  
  126. F11       Toggles speed display.
  127.  
  128. Shift+F11 Toggles internal profiler display (if compiled in).
  129.  
  130. F12       Saves a screen snapshot.
  131.  
  132. Insert    Fast forward. While held, runs the game with throttling disabled
  133.           and with the maximum frameskip.
  134.  
  135. Escape    Exits emulator.
  136.  
  137.  
  138.  
  139.  
  140. Core commands
  141. -------------
  142.  
  143. -help / -h / -?
  144.  
  145.     Displays current MAME version and copyright notice.
  146.  
  147. -validate / -valid
  148.  
  149.     Performs internal validation on every driver in the system. Run this
  150.     before submitting changes to ensure that you haven't violated any of
  151.     the core system rules.
  152.  
  153.  
  154.  
  155. Configuration commands
  156. ----------------------
  157.  
  158. -createconfig / -cc
  159.  
  160.     Creates the default mame.ini file. All the configuration options
  161.     (not commands) described below can be permanently changed by editing
  162.     this configuration file.
  163.  
  164. -showconfig / -sc
  165.  
  166.     Displays the current configuration settings. If you route this to a
  167.     file, you can use it as an INI file. For example, the command:
  168.  
  169.         mame -showconfig >mame.ini
  170.  
  171.     is equivalent to -createconfig.
  172.  
  173. -showusage / -su
  174.  
  175.     Displays a summary of all the command line options. For options that
  176.     are not mentioned here, the short summary given by "mame -showusage"
  177.     is usually sufficient.
  178.  
  179.  
  180.  
  181. Frontend commands
  182. -----------------
  183.  
  184. Note: By default, all the '-list' commands below write info to the screen.
  185. If you wish to write the info to a textfile instead, add this to the end
  186. of your command:
  187.  
  188.   > filename
  189.  
  190. ...where 'filename' is the textfile's path and name
  191. (e.g., c:\mame\list.txt).
  192.  
  193. -listxml / -lx [<gamename|wildcard>]
  194.  
  195.     List comprehensive details for all of the supported games. The output
  196.     is quite long, so it is usually better to redirect this into a file.
  197.     The output is in XML format. By default all games are listed; however,
  198.     you can limit this list by specifying a driver name or wildcard after
  199.     the -listxml command.
  200.  
  201. -listfull / -ll [<gamename|wildcard>]
  202.  
  203.     Displays a list of game driver names and descriptions. By default all
  204.     games are listed; however, you can limit this list by specifying a
  205.     driver name or wildcard after the -listfull command.
  206.  
  207. -listsource / -ls [<gamename|wildcard>]
  208.  
  209.     Displays a list of drivers and the names of the source files their
  210.     game drivers live in. Useful for finding which driver a game runs on
  211.     in order to fix bugs. By default all games are listed; however, you
  212.     can limit this list by specifying a driver name or wildcard after
  213.     the -listsource command.
  214.  
  215. -listclones / -lc [<gamename|wildcard>]
  216.  
  217.     Displays a list of clones. By default all clones are listed; however,
  218.     you can limit this list by specifying a driver name or wildcard after
  219.     the -listsource command.
  220.  
  221. -listcrc
  222.  
  223.     Displays a full list of CRCs of all ROM images referenced by all
  224.     drivers within MAME.
  225.  
  226. -listroms <gamename>
  227.  
  228.     Displays a list of ROM images referenced by the specified game.
  229.  
  230. -listsamples <gamename>
  231.  
  232.     Displays a list of samples referenced by the specified game.
  233.  
  234. -verifyroms [<gamename|wildcard>]
  235.  
  236.     Checks for invalid or missing ROM images. By default all drivers that
  237.     have valid ZIP files or directories in the rompath are verified;
  238.     however, you can limit this list by specifying a driver name or
  239.     wildcard after the -verifyroms command.
  240.  
  241. -verifysamples [<gamename|wildcard>]
  242.  
  243.     Checks for invalid or missing samples. By default all drivers that
  244.     have valid ZIP files or directories in the samplepath are verified;
  245.     however, you can limit this list by specifying a driver name or
  246.     wildcard after the -verifyroms command.
  247.  
  248. -romident
  249.  
  250.     Attempts to identify ROM files, if they are known to MAME, in the
  251.     specified .zip file or directory. This command can be used to try and
  252.     identify ROM sets taken from unknown boards. On exit, the errorlevel
  253.     is returned as one of the following:
  254.  
  255.         0: means all files were identified
  256.         7: means all files were identified except for 1 or more "non-ROM"
  257.             files
  258.         8: means some files were identified
  259.         9: means no files were identified
  260.  
  261.  
  262.  
  263. Configuration options
  264. ---------------------
  265.  
  266. -[no]readconfig / -[no]rc
  267.  
  268.     Enables or disables the reading of the config files. When enabled
  269.     (which is the default), MAME reads the following config files in order:
  270.  
  271.         - mame.ini
  272.         - <mymame>.ini (i.e. if MAME was renamed mame060.exe, MAME
  273.                 parses mame060.ini here)
  274.         - debug.ini (if the debugger is enabled)
  275.         - vector.ini (for vector games only)
  276.         - <driver>.ini (based on the source filename of the driver)
  277.         - <parent>.ini (for clones only, may be called recursively)
  278.         - <gamename>.ini
  279.  
  280.     The settings in the later ini's override those in the earlier ini's.
  281.     So, for example, if you wanted to disable overlay effects in the
  282.     vector games, you can create a vector.ini with the "effect none" line
  283.     in it, and it will override whatever effect value you have in your
  284.     mame.ini. The default is ON (-readconfig).
  285.  
  286.  
  287.  
  288. Core search path options
  289. ------------------------
  290.  
  291. -rompath / -rp <path>
  292.  
  293.     Specifies a list of paths within which to find ROM or hard disk images.
  294.     Multiple paths can be specified by separating them with semicolons.
  295.     The default is 'roms' (that is, a directory "roms" in the same directory
  296.     as the MAME executable).
  297.  
  298. -samplepath / -sp <path>
  299.  
  300.     Specifies a list of paths within which to find sample files. Multiple
  301.     paths can be specified by separating them with semicolons. The default
  302.     is 'samples' (that is, a directory "samples" in the same directory as
  303.     the MAME executable).
  304.  
  305. -artpath / -artwork_directory <path>
  306.  
  307.     Specifies a list of paths within which to find artwork files. Multiple
  308.     paths can be specified by separating them with semicolons. The default
  309.     is 'artwork' (that is, a directory "artwork" in the same directory as
  310.     the MAME executable).
  311.  
  312. -ctrlrpath / -ctrlr_directory <path>
  313.  
  314.     Specifies a list of paths within which to find controller-specific
  315.     configuration files. Multiple paths can be specified by separating
  316.     them with semicolons. The default is 'ctrlr' (that is, a directory
  317.     "ctrlr" in the same directory as the MAME executable).
  318.  
  319. -inipath <path>
  320.  
  321.     Specifies a list of paths within which to find .INI files. Multiple
  322.     paths can be specified by separating them with semicolons. The default
  323.     is '.;ini' (that is, search in the current directory first, and then
  324.     in the directory "ini" in the same directory as the MAME executable).
  325.  
  326. -fontpath <path>
  327.  
  328.     Specifies a list of paths within which to find .BDF font files. Multiple
  329.     paths can be specified by separating them with semicolons. The default
  330.     is '.' (that is, search in the same directory as the MAME executable).
  331.  
  332. -crsshairpath <path>
  333.  
  334.     Specifies a list of paths within which to find crosshair files. Multiple
  335.     paths can be specified by separating them with semicolons. The default
  336.     is 'crsshair' (that is, a directory "crsshair" in the same directory as
  337.     the MAME executable).  If the Crosshair is set to default in the menu,
  338.     MAME will look for gamename\cross#.png and then cross#.png in the
  339.     specified crsshairpath, where # is the player number.  Failing that,
  340.     MAME will use built-in default crosshairs.
  341.  
  342.  
  343. Core Output Directory Options
  344. -----------------------------
  345.  
  346. -cfg_directory <path>
  347.  
  348.     Specifies a single directory where configuration files are stored.
  349.     Configuration files store user configurable settings that are read at
  350.     startup and written when MAME exits. The default is 'cfg' (that is,
  351.     a directory "cfg" in the same directory as the MAME executable). If
  352.     this directory does not exist, it will be automatically created.
  353.  
  354. -nvram_directory <path>
  355.  
  356.     Specifies a single directory where NVRAM files are stored. NVRAM files
  357.     store the contents of EEPROM and non-volatile RAM (NVRAM) for games
  358.     which used this type of hardware. This data is read at startup and
  359.     written when MAME exits. The default is 'nvram' (that is, a directory
  360.     "nvram" in the same directory as the MAME executable). If this
  361.     directory does not exist, it will be automatically created.
  362.  
  363. -memcard_directory <path>
  364.  
  365.     Specifies a single directory where memory card files are stored.
  366.     Memory card files store the contents of removable memory cards for
  367.     games which used this type of hardware. This data is read and written
  368.     under control of the user via the "Memory Card" menu in the user
  369.     interface. The default is 'memcard' (that is, a directory "memcard"
  370.     in the same directory as the MAME executable). If this directory does
  371.     not exist, it will be automatically created.
  372.  
  373. -input_directory <path>
  374.  
  375.     Specifies a single directory where input recording files are stored.
  376.     Input recordings are created via the -record option and played back
  377.     via the -playback option. The default is 'inp' (that is, a directory
  378.     "inp" in the same directory as the MAME executable). If this directory
  379.     does not exist, it will be automatically created.
  380.  
  381. -state_directory <path>
  382.  
  383.     Specifies a single directory where save state files are stored. Save
  384.     state files are read and written either upon user request, or when
  385.     using the -autosave option. The default is 'sta' (that is, a directory
  386.     "sta" in the same directory as the MAME executable). If this directory
  387.     does not exist, it will be automatically created.
  388.  
  389. -snapshot_directory <path>
  390.  
  391.     Specifies a single directory where screen snapshots are stored, when
  392.     requested by the user. The default is 'snap' (that is, a directory
  393.     "snap" in the same directory as the MAME executable). If this
  394.     directory does not exist, it will be automatically created.
  395.  
  396. -diff_directory <path>
  397.  
  398.     Specifies a single directory where hard drive differencing files are
  399.     stored. Hard drive differencing files store any data that is written
  400.     back to a hard disk image, in order to preserve the original image.
  401.     The differencing files are created at startup when a game with a hard
  402.     disk image. The default is 'diff' (that is, a directory "diff" in the
  403.     same directory as the MAME executable). If this directory does not
  404.     exist, it will be automatically created.
  405.  
  406. -comment_directory <path>
  407.  
  408.     Specifies a single directory where debugger comment files are stored.
  409.     Debugger comment files are written by the debugger when comments are
  410.     added to the disassembly for a game. The default is 'comments' (that
  411.     is, a directory "comments" in the same directory as the MAME
  412.     executable). If this directory does not exist, it will be
  413.     automatically created.
  414.  
  415.  
  416.  
  417. Core Filename Options
  418. ---------------------
  419.  
  420. -cheat_file <filename>
  421.  
  422.     Specifies the name of the cheat database file. The default is
  423.     'cheat.dat'.
  424.  
  425.  
  426.  
  427. Core state/playback options
  428. ---------------------------
  429.  
  430. -state <slot>
  431.  
  432.     Immediately after starting the specified game, will cause the save
  433.     state in the specified <slot> to be loaded.
  434.  
  435. -[no]autosave
  436.  
  437.     When enabled, automatically creates a save state file when exiting
  438.     MAME and automatically attempts to reload it when later starting MAME
  439.     with the same game. This only works for games that have explicitly
  440.     enabled save state support in their driver. The default is OFF
  441.     (-noautosave).
  442.  
  443. -playback / -pb <filename>
  444.  
  445.     Specifies a file from which to play back a series of game inputs. This
  446.     feature does not work reliably for all games, but can be used to watch
  447.     a previously recorded game session from start to finish. In order to
  448.     make things consistent, you should only record and playback with all
  449.     configuration (.cfg), NVRAM (.nv), and memory card files deleted. The
  450.     default is NULL (no playback).
  451.  
  452. -record / -rec <filename>
  453.  
  454.     Specifies a file to record all input from a game session. This can be
  455.     used to record a game session for later playback. This feature does
  456.     not work reliably for all games, but can be used to watch a previously
  457.     recorded game session from start to finish. In order to make things
  458.     consistent, you should only record and playback with all configuration
  459.     (.cfg), NVRAM (.nv), and memory card files deleted. The default is
  460.     NULL (no recording).
  461.  
  462. -snapname <name>
  463.  
  464.     Describes how MAME should name files for snapshots. <name> is a string
  465.     that provides a template that is used to generate a filename. Three
  466.     simple substitutions are provided: the / character represents the
  467.     path separator on any target platform (even Windows); the string %g
  468.     represents the driver name of the current game; and the string %i
  469.     represents an incrementing index. If %i is omitted, then each
  470.     snapshot taken will overwrite the previous one; otherwise, MAME will
  471.     find the next empty value for %i and use that for a filename. The
  472.     default is %g/%i, which creates a separate folder for each game,
  473.     and names the snapshots under it starting with 0000 and increasing
  474.     from there.
  475.  
  476. -snapsize <width>x<height>
  477.  
  478.     Hard-codes the size for snapshots and movie recording. By default,
  479.     MAME will create snapshots at the game's current resolution in raw
  480.     pixels, and will create movies at the game's starting resolution in
  481.     raw pixels. If you specify this option, then MAME will create both
  482.     snapshots and movies at the size specified, and will bilinear filter
  483.     the result. Note that this size does not automatically rotate if the
  484.     game is vertically oriented. The default is 'auto'.
  485.  
  486. -snapview <viewname>
  487.  
  488.     Specifies the view to use when rendering snapshots and movies. By
  489.     default, both use a special 'internal' view, which renders a separate
  490.     snapshot per screen or renders movies only of the first screen. By
  491.     specifying this option, you can override this default behavior and
  492.     select a single view that will apply to all snapshots and movies.
  493.     Note that <viewname> does not need to be a perfect match; rather, it
  494.     will select the first view whose name matches all the characters
  495.     specified by <viewname>. For example, -snapview native will match the
  496.     "Native (15:14)" view even though it is not a perfect match.
  497.     <viewname> can also be 'auto', which selects the first view with all
  498.     screens present. The default value is 'internal'.
  499.  
  500. -mngwrite <filename>
  501.  
  502.     Writes each video frame to the given <filename> in MNG format,
  503.     producing an animation of the game session. Note that -mngwrite only
  504.     writes video frames; it does not save any audio data. Use -wavwrite
  505.     for that, and reassemble the audio/video using offline tools. The
  506.     default is NULL (no recording).
  507.  
  508. -aviwrite <filename>
  509.  
  510.     Stream video and sound data to the given <filename> in AVI format,
  511.     producing an animation of the game session complete with sound. The
  512.     default is NULL (no recording).
  513.  
  514. -wavwrite <filename>
  515.  
  516.     Writes the final mixer output to the given <filename> in WAV format,
  517.     producing an audio recording of the    game session. The default is
  518.     NULL (no recording).
  519.  
  520.  
  521.  
  522. Core performance options
  523. ------------------------
  524.  
  525. -[no]autoframeskip / -[no]afs
  526.  
  527.     Automatically determines the frameskip level while you're playing the
  528.     game, adjusting it constantly in a frantic attempt to keep the game
  529.     running at full speed. Turning this on overrides the value you have
  530.     set for -frameskip below. The default is OFF (-noautoframeskip).
  531.  
  532. -frameskip / -fs <level>
  533.  
  534.     Specifies the frameskip value. This is the number of frames out of
  535.     every 12 to drop when running. For example, if you say -frameskip 2,
  536.     then MAME will display 10 out of every 12 frames. By skipping those
  537.     frames, you may be able to get full speed in a game that requires more
  538.     horsepower than your computer has. The default value is -frameskip 0,
  539.     which skips no frames.
  540.  
  541. -seconds_to_run / -str <seconds>
  542.  
  543.     This option can be used for benchmarking and automated testing. It tells
  544.     MAME to stop execution after a fixed number of seconds. By combining
  545.     this with a fixed set of other command line options, you can set up a
  546.     consistent environment for benchmarking MAME performance. In addition,
  547.     upon exit, the -str option will write a screenshot called final.png
  548.     to the game's snapshot directory.
  549.  
  550. -[no]throttle
  551.  
  552.     Configures the default thottling setting. When throttling is on, MAME
  553.     attempts to keep the game running at the game's intended speed. When
  554.     throttling is off, MAME runs the game as fast as it can. Note that the
  555.     fastest speed is more often than not limited by your graphics card,
  556.     especially for older games. The default is ON (-throttle).
  557.  
  558. -[no]sleep
  559.  
  560.     Allows MAME to give time back to the system when running with -throttle.
  561.     This allows other programs to have some CPU time, assuming that the
  562.     game isn't taxing 100% of your CPU resources. This option can
  563.     potentially cause hiccups in performance if other demanding programs
  564.     are running. The default is ON (-sleep).
  565.  
  566. -speed <factor>
  567.  
  568.     Changes the way MAME throttles gameplay such that the game runs at some
  569.     multiplier of the original speed. A <factor> of 1.0 means to run the
  570.     game at its normal speed. A <factor> of 0.5 means run at half speed,
  571.     and a <factor> of 2.0 means run at 2x speed. Note that changing this
  572.     value affects sound playback as well, which will scale in pitch
  573.     accordingly. The internal resolution of the fraction is two decimal
  574.     places, so a value of 1.002 is the same as 1.0. The default is 1.0.
  575.  
  576. -[no]refreshspeed / -[no]rs
  577.  
  578.     Allows MAME to dynamically adjust the gameplay speed such that it does
  579.     not exceed the slowest refresh rate for any targeted monitors in your
  580.     system. Thus, if you have a 60Hz monitor and run a game that is
  581.     actually designed to run at 60.6Hz, MAME will dynamically change the
  582.     speed down to 99% in order to prevent sound hiccups or other
  583.     undesirable side effects of running at a slower refresh rate. The
  584.     default is OFF (-norefreshspeed).
  585.  
  586.  
  587.  
  588. Core rotation options
  589. ---------------------
  590.  
  591. -[no]rotate
  592.  
  593.     Rotate the game to match its normal state (horizontal/vertical). This
  594.     ensures that both vertically and horizontally oriented games show up
  595.     correctly without the need to rotate your monitor. If you want to keep
  596.     the game displaying 'raw' on the screen the way it would have in the
  597.     arcade, turn this option OFF. The default is ON (-rotate).
  598.  
  599. -[no]ror
  600. -[no]rol
  601.  
  602.     Rotate the game screen to the right (clockwise) or left (counter-
  603.     clockwise) relative to either its normal state (if -rotate is
  604.     specified) or its native state (if -norotate is specified). The
  605.     default for both of these options is OFF (-noror -norol).
  606.  
  607. -[no]flipx
  608. -[no]flipy
  609.  
  610.     Flip (mirror) the game screen either horizontally (-flipx) or
  611.     vertically (-flipy). The flips are applied after the -rotate and
  612.     -ror/-rol options are applied. The default for both of these options
  613.     is OFF (-noflipx -noflipy).
  614.  
  615. -[no]autoror
  616. -[no]autorol
  617.  
  618.     These options are designed for use with pivoting screens that only
  619.     pivot in a single direction. If your screen only pivots clockwise,
  620.     use -autorol to ensure that the game will fill the screen either
  621.     horizontally or vertically in one of the directions you can handle.
  622.     If your screen only pivots counter-clockwise, use -autoror.
  623.  
  624.  
  625.  
  626. Core artwork options
  627. --------------------
  628.  
  629. -[no]artwork_crop / -[no]artcrop
  630.  
  631.     Enable cropping of artwork to the game screen area only. This works
  632.     best with -video gdi or -video d3d, and means that vertically oriented
  633.     games running full screen can display their artwork to the left and
  634.     right sides of the screen. This does not work with -video ddraw
  635.     because of the way the game screens are rendered and scaled after the
  636.     fact. This option can also be controlled via the Video Options menu in
  637.     the user interface. The default is OFF (-noartwork_crop).
  638.  
  639. -[no]use_backdrops / -[no]backdrop
  640.  
  641.     Enables/disables the display of backdrops. The default is ON
  642.     (-use_backdrops).
  643.  
  644. -[no]use_overlays / -[no]overlay
  645.  
  646.     Enables/disables the display of overlays. The default is ON
  647.     (-use_overlays).
  648.  
  649. -[no]use_bezels / -[no]bezel
  650.  
  651.     Enables/disables the display of bezels. The default is ON
  652.     (-use_bezels).
  653.  
  654.  
  655.  
  656. Core screen options
  657. -------------------
  658.  
  659. -brightness <value>
  660.  
  661.     Controls the default brightness, or black level, of the game screens.
  662.     This option does not affect the artwork or other parts of the display.
  663.     Using the MAME UI, you can individually set the brightness for each
  664.     game screen; this option controls the initial value for all visible
  665.     game screens. The standard value is 1.0. Selecting lower values (down
  666.     to 0.1) will produce a darkened display, while selecting higher values
  667.     (up to 2.0) will give a brighter display. The default is 1.0.
  668.  
  669. -contrast <value>
  670.  
  671.     Controls the contrast, or white level, of the game screens. This
  672.     option does not affect the artwork or other parts of the display.
  673.     Using the MAME UI, you can individually set the contrast for each
  674.     game screen; this option controls the initial value for all visible
  675.     game screens. The standard value is 1.0. Selecting lower values (down
  676.     to 0.1) will produce a dimmer display, while selecting higher values
  677.     (up to 2.0) will give a more saturated display. The default is 1.0.
  678.  
  679. -gamma <value>
  680.  
  681.     Controls the gamma, which produces a potentially nonlinear black to
  682.     white ramp, for the game screens. This option does not affect the
  683.     artwork or other parts of the display. Using the MAME UI, you can
  684.     individually set the gamma for each game screen; this option controls
  685.     the initial value for all visible game screens. The standard value is
  686.     1.0, which gives a linear ramp from black to white. Selecting lower
  687.     values (down to 0.1) will increase the nonlinearity toward black,
  688.     while selecting higher values (up to 3.0) will push the nonlinearity
  689.     toward white. The default is 1.0.
  690.  
  691. -pause_brightness <value>
  692.  
  693.     This controls the brightness level when MAME is paused. The default
  694.     value is 0.65.
  695.  
  696.  
  697.  
  698. Core vector options
  699. -------------------
  700.  
  701. -[no]antialias / -[no]aa
  702.  
  703.     Enables antialiased line rendering for vector games. The default is ON
  704.     (-antialias).
  705.  
  706. -beam <width>
  707.  
  708.     Sets the width of the vectors. This is a scaling factor against the
  709.     standard vector width. A value of 1.0 will keep the default vector
  710.     line width. Smaller values will reduce the width, and larger values
  711.     will increase the width. The default is 1.0.
  712.  
  713. -flicker <value>
  714.  
  715.     Simulates a vector "flicker" effect, similar to a vector monitor that
  716.     needs adjustment. This option requires a float argument in the range
  717.     of 0.00 - 100.00 (0=none, 100=maximum). The default is 0.
  718.  
  719.  
  720.  
  721. Core sound options
  722. ------------------
  723.  
  724. -[no]sound
  725.  
  726.     Enable or disable sound altogether. The default is ON (-sound).
  727.  
  728. -samplerate <value> / -sr <value>
  729.  
  730.     Sets the audio sample rate. Smaller values (e.g. 11025) cause lower
  731.     audio quality but faster emulation speed. Higher values (e.g. 48000)
  732.     cause higher audio quality but slower emulation speed. The default is
  733.     48000.
  734.  
  735. -[no]samples
  736.  
  737.     Use samples if available. The default is ON (-samples).
  738.  
  739. -volume / -vol <value>
  740.  
  741.     Sets the startup volume. It can later be changed with the user
  742.     interface (see Keys section). The volume is an attenuation in dB:
  743.     e.g., "-volume -12" will start with -12dB attenuation. The default
  744.     is 0.
  745.  
  746.  
  747.  
  748. Core input options
  749. ------------------
  750.  
  751. -[no]coin_lockout / -[no]coinlock
  752.  
  753.     Enables simulation of the "coin lockout" feature that is implmeneted
  754.     on a number of game PCBs. It was up to the operator whether or not
  755.     the coin lockout outputs were actually connected to the coin
  756.     mechanisms. If this feature is enabled, then attempts to enter a coin
  757.     while the lockout is active will fail and will display a popup message
  758.     in the user interface. If this feature is disabled, the coin lockout
  759.     signal will be ignored. The default is ON (-coin_lockout).
  760.  
  761. -ctrlr <controller>
  762.  
  763.     Enables support for special controllers. Configuration files are
  764.     loaded from the ctrlrpath. They are in the same format as the .cfg
  765.     files that are saved, but only control configuration data is read
  766.     from the file. The default is NULL (no controller file).
  767.  
  768. -[no]mouse
  769.  
  770.     Controls whether or not MAME makes use of mouse controllers. When
  771.     this is enabled, you will likely be unable to use your mouse for other
  772.     purposes until you exit or pause the game. The default is OFF
  773.     (-nomouse).
  774.  
  775. -[no]joystick / -[no]joy
  776.  
  777.     Controls whether or not MAME makes use of joystick/gamepad controllers.
  778.     When this is enabled, MAME will ask DirectInput about which
  779.     controllers are connected. The default is OFF (-nojoystick).
  780.  
  781. -[no]lightgun / -[no]gun
  782.  
  783.     Controls whether or not MAME makes use of lightgun controllers.
  784.     Note that most lightguns map to the mouse, so using -lightgun and
  785.     -mouse together may produce strange results. The default is OFF
  786.     (-nolightgun).
  787.  
  788. -[no]multikeyboard / -[no]multikey
  789.  
  790.     Determines whether MAME differentiates between multiple keyboards.
  791.     Some systems may report more than one keyboard; by default, the data
  792.     from all of these keyboards is combined so that it looks like a single
  793.     keyboard. Turning this option on will enable MAME to report keypresses
  794.     on different keyboards independently. The default is OFF
  795.     (-nomultikeyboard).
  796.  
  797. -[no]multimouse
  798.  
  799.     Determines whether MAME differentiates between multiple mice. Some
  800.     systems may report more than one mouse device; by default, the data
  801.     from all of these mice is combined so that it looks like a single
  802.     mouse. Turning this option on will enable MAME to report mouse
  803.     movement and button presses on different mice independently. The
  804.     default is OFF (-nomultimouse).
  805.  
  806. -[no]steadykey / -[no]steady
  807.  
  808.     Some games require two or more buttons to be pressed at exactly the
  809.     same time to make special moves. Due to limitations in the keyboard
  810.     hardware, it can be difficult or even impossible to accomplish that
  811.     using the standard keyboard handling. This option selects a different
  812.     handling that makes it easier to register simultaneous button presses,
  813.     but has the disadvantage of making controls less responsive. The
  814.     default is OFF (-nosteadykey)
  815.  
  816. -[no]offscreen_reload / -[no]reload
  817.  
  818.     Controls whether or not MAME treats a second button input from a
  819.     lightgun as a reload signal. In this case, MAME will report the gun's
  820.     position as (0,MAX) with the trigger held, which is equivalent to an
  821.     offscreen reload. This is only needed for games that required you to
  822.     shoot offscreen to reload, and then only if your gun does not support
  823.     off screen reloads. The default is OFF (-nooffscreen_reload).
  824.  
  825. -joystick_map <map> / -joymap <map>
  826.  
  827.     Controls how joystick values map to digital joystick controls. MAME
  828.     accepts all joystick input from the system as analog data. For true
  829.     analog joysticks, this needs to be mapped down to the usual 4-way or
  830.     8-way digital joystick values. To do this, MAME divides the analog
  831.     range into a 9x9 grid. It then takes the joystick axis position (for
  832.     X and Y axes only), maps it to this grid, and then looks up a
  833.     translation from a joystick map. This parameter allows you to specify
  834.     the map. The default is 'auto', which means that a standard 8-way,
  835.     4-way, or 4-way diagonal map is selected automatically based on the
  836.     input port configuration of the current game.
  837.  
  838.     Maps are defined as a string of numbers and characters. Since the grid
  839.     is 9x9, there are a total of 81 characters necessary to define a
  840.     complete map. Below is an example map for an 8-way joystick:
  841.  
  842.         777888999    Note that the numeric digits correspond to the keys
  843.         777888999    on a numeric keypad. So '7' maps to up+left, '4' maps
  844.         777888999    to left, '5' maps to neutral, etc. In addition to the
  845.         444555666    numeric values, you can specify the character 's',
  846.         444555666    which means "sticky". In this case, the value of the
  847.         444555666    map is the same as it was the last time a non-sticky
  848.         111222333    value was read.
  849.         111222333
  850.         111222333
  851.  
  852.     To specify the map for this parameter, you can specify a string of
  853.     rows separated by a '.' (which indicates the end of a row), like so:
  854.  
  855.         777888999.777888999.777888999.444555666.444555666.444555666.
  856.         111222333.111222333.111222333
  857.  
  858.     However, this can be reduced using several shorthands supported by the
  859.     <map> parameter. If information about a row is missing, then it is
  860.     assumed that any missing data in columns 5-9 are left/right symmetric
  861.     with data in columns 0-4; and any missing data in colums 0-4 is
  862.     assumed to be copies of the previous data. The same logic applies to
  863.     missing rows, except that up/down symmetry is assumed.
  864.  
  865.     By using these shorthands, the 81 character map can be simply
  866.     specified by this 11 character string: 7778...4445
  867.  
  868.     Looking at the first row, 7778 is only 4 characters long. The 5th
  869.     entry can't use symmetry, so it is assumed to be equal to the previous
  870.     character '8'. The 6th character is left/right symmetric with the 4th
  871.     character, giving an '8'. The 7th character is left/right symmetric
  872.     with the 3rd character, giving a '9' (which is '7' with left/right
  873.     flipped). Eventually this gives the full 777888999 string of the row.
  874.  
  875.     The second and third rows are missing, so they are assumed to be
  876.     identical to the first row. The fourth row decodes similarly to the
  877.     first row, producing 444555666. The fifth row is missing so it is
  878.     assumed to be the same as the fourth.
  879.  
  880.     The remaining three rows are also missing, so they are assumed to be
  881.     the up/down mirrors of the first three rows, giving three final rows
  882.     of 111222333.
  883.  
  884. -joystick_deadzone <value> / -joy_deadzone <value> / -jdz <value>
  885.  
  886.     If you play with an analog joystick, the center can drift a little.
  887.     joystick_deadzone tells how far along an axis you must move before the
  888.     axis starts to change. This option expects a float in the range of
  889.     0.0 to 1.0. Where 0 is the center of the joystick and 1 is the outer
  890.     limit. The default is 0.3.
  891.  
  892. -joystick_saturation <value> / joy_saturation <value> / -jsat <value>
  893.  
  894.     If you play with an analog joystick, the ends can drift a little,
  895.     and may not match in the +/- directions. joystick_saturation tells how
  896.     far along an axis movement change will be accepted before it reaches
  897.     the maximum range. This option expects a float in the range of 0.0 to
  898.     1.0, where 0 is the center of the joystick and 1 is the outer limit.
  899.     The default is 0.85.
  900.  
  901.  
  902.  
  903. Core input automatic enable options
  904. -----------------------------------
  905.  
  906. -paddle_device <keyboard|mouse|joystick|lightgun|none> / -paddle
  907. -adstick_device <keyboard|mouse|joystick|lightgun|none> / -adstick
  908. -pedal_device <keyboard|mouse|joystick|lightgun|none> / -pedal
  909. -dial_device <keyboard|mouse|joystick|lightgun|none> / -dial
  910. -trackball_device <keyboard|mouse|joystick|lightgun|none> / -trackball
  911. -lightgun_device <keyboard|mouse|joystick|lightgun|none>
  912. -positional_device <keyboard|mouse|joystick|lightgun|none>
  913.  
  914.     Each of these options controls autoenabling the mouse, joystick, or
  915.     lightgun depending on the presence of a particular class of analog
  916.     control for a particular game. For example, if you specify the option
  917.     -paddle mouse, then any game that has a paddle control will
  918.     automatically enable mouse controls just as if you had explicitly
  919.     specified -mouse. Note that these controls override the values of
  920.     -[no]mouse, -[no]joystick, etc.
  921.  
  922.  
  923.  
  924. Debugging options
  925. -----------------
  926.  
  927. -[no]log
  928.  
  929.     Creates a file called error.log which contains all of the internal
  930.     log messages generated by the MAME core and game drivers. The default
  931.     is OFF (-nolog).
  932.  
  933. -[no]verbose / -[no]v
  934.  
  935.     Displays internal diagnostic information. This information is very
  936.     useful for debugging problems with your configuration. IMPORTANT: when
  937.     reporting bugs, please run with mame -verbose and include the
  938.     resulting information. The default is OFF (-noverbose).
  939.  
  940. -[no]update_in_pause
  941.  
  942.     Enables updating of the main screen bitmap while the game is paused.
  943.     This means that the VIDEO_UPDATE callback will be called repeatedly
  944.     during pause, which can be useful for debugging. The default is OFF
  945.     (-noupdate_in_pause).
  946.  
  947. -[no]debug
  948.  
  949.     Activates the integrated debugger. By default, the debugger is entered
  950.     by pressing the tilde (~) key during emulation. It is also entered
  951.     immediately at startup. The default is OFF (-nodebug).
  952.  
  953. -debugscript <filename>
  954.  
  955.     Specifies a file that contains a list of debugger commands to execute
  956.     immediately upon startup. The default is NULL (no commands).
  957.  
  958.  
  959.  
  960. Core misc options
  961. -----------------
  962.  
  963. -bios <biosname>
  964.  
  965.     Specifies the specific BIOS to use with the current game, for game
  966.     systems that make use of a BIOS. The -listxml output will list all of
  967.     the possible BIOS names for a game. The default is 'default'.
  968.  
  969. -[no]cheat / -[no]c
  970.  
  971.     Enables the reading of the cheat database, if present, and the Cheat
  972.     menu in the user interface. The    default is OFF (-nocheat).
  973.  
  974. -[no]skip_gameinfo
  975.  
  976.     Forces MAME to skip displaying the game info screen. The default is
  977.     OFF (-noskip_gameinfo).
  978.